<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9"/>
<title>NGUI: UIPlayAnimation Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">NGUI
   &#160;<span id="projectnumber">3.11.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_u_i_play_animation.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="class_u_i_play_animation-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">UIPlayAnimation Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Play the specified animation on click.  
 <a href="class_u_i_play_animation.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for UIPlayAnimation:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_u_i_play_animation.png" usemap="#UIPlayAnimation_map" alt=""/>
  <map id="UIPlayAnimation_map" name="UIPlayAnimation_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afe99df78a87e0217498c40ff78ea9b17"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_animation.html#afe99df78a87e0217498c40ff78ea9b17">Play</a> (bool forward)</td></tr>
<tr class="memdesc:afe99df78a87e0217498c40ff78ea9b17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start playing the animation.  <a href="#afe99df78a87e0217498c40ff78ea9b17">More...</a><br /></td></tr>
<tr class="separator:afe99df78a87e0217498c40ff78ea9b17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d04928eb41301c4cb4b6ca7ce946f9f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_animation.html#a8d04928eb41301c4cb4b6ca7ce946f9f">Play</a> (bool forward, bool onlyIfDifferent)</td></tr>
<tr class="memdesc:a8d04928eb41301c4cb4b6ca7ce946f9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start playing the animation.  <a href="#a8d04928eb41301c4cb4b6ca7ce946f9f">More...</a><br /></td></tr>
<tr class="separator:a8d04928eb41301c4cb4b6ca7ce946f9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c89e1cd6619bfd36a22ca130f08f763"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_animation.html#a2c89e1cd6619bfd36a22ca130f08f763">PlayForward</a> ()</td></tr>
<tr class="memdesc:a2c89e1cd6619bfd36a22ca130f08f763"><td class="mdescLeft">&#160;</td><td class="mdescRight">Play the tween forward.  <a href="#a2c89e1cd6619bfd36a22ca130f08f763">More...</a><br /></td></tr>
<tr class="separator:a2c89e1cd6619bfd36a22ca130f08f763"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a605acb0df7576c45eff1ea7e4b645e8d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_animation.html#a605acb0df7576c45eff1ea7e4b645e8d">PlayReverse</a> ()</td></tr>
<tr class="memdesc:a605acb0df7576c45eff1ea7e4b645e8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Play the tween in reverse.  <a href="#a605acb0df7576c45eff1ea7e4b645e8d">More...</a><br /></td></tr>
<tr class="separator:a605acb0df7576c45eff1ea7e4b645e8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a7129ebde8edb46b2353be0dbc1a8dc59"><td class="memItemLeft" align="right" valign="top">Animation&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_animation.html#a7129ebde8edb46b2353be0dbc1a8dc59">target</a></td></tr>
<tr class="memdesc:a7129ebde8edb46b2353be0dbc1a8dc59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Target animation to activate.  <a href="#a7129ebde8edb46b2353be0dbc1a8dc59">More...</a><br /></td></tr>
<tr class="separator:a7129ebde8edb46b2353be0dbc1a8dc59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02c7edf8e02c531fd63bb7ec3a0f6f8e"><td class="memItemLeft" align="right" valign="top">Animator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_animation.html#a02c7edf8e02c531fd63bb7ec3a0f6f8e">animator</a></td></tr>
<tr class="memdesc:a02c7edf8e02c531fd63bb7ec3a0f6f8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Target animator system.  <a href="#a02c7edf8e02c531fd63bb7ec3a0f6f8e">More...</a><br /></td></tr>
<tr class="separator:a02c7edf8e02c531fd63bb7ec3a0f6f8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d588b3baf27ba6dd26a122baa0559fa"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_animation.html#a9d588b3baf27ba6dd26a122baa0559fa">clipName</a></td></tr>
<tr class="memdesc:a9d588b3baf27ba6dd26a122baa0559fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional clip name, if the animation has more than one clip.  <a href="#a9d588b3baf27ba6dd26a122baa0559fa">More...</a><br /></td></tr>
<tr class="separator:a9d588b3baf27ba6dd26a122baa0559fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb7d8fcf9427dea42335e7061bea8710"><td class="memItemLeft" align="right" valign="top">Trigger&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_animation.html#afb7d8fcf9427dea42335e7061bea8710">trigger</a> = Trigger.OnClick</td></tr>
<tr class="memdesc:afb7d8fcf9427dea42335e7061bea8710"><td class="mdescLeft">&#160;</td><td class="mdescRight">Which event will trigger the animation.  <a href="#afb7d8fcf9427dea42335e7061bea8710">More...</a><br /></td></tr>
<tr class="separator:afb7d8fcf9427dea42335e7061bea8710"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a258bbfffec956070be6c4209b2b0b14c"><td class="memItemLeft" align="right" valign="top">Direction&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_animation.html#a258bbfffec956070be6c4209b2b0b14c">playDirection</a> = Direction.Forward</td></tr>
<tr class="memdesc:a258bbfffec956070be6c4209b2b0b14c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Which direction to animate in.  <a href="#a258bbfffec956070be6c4209b2b0b14c">More...</a><br /></td></tr>
<tr class="separator:a258bbfffec956070be6c4209b2b0b14c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd2f2ed7d50c3dc96952f8a61e15817e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_animation.html#abd2f2ed7d50c3dc96952f8a61e15817e">resetOnPlay</a> = false</td></tr>
<tr class="memdesc:abd2f2ed7d50c3dc96952f8a61e15817e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the animation's position will be reset on play or will continue from where it left off.  <a href="#abd2f2ed7d50c3dc96952f8a61e15817e">More...</a><br /></td></tr>
<tr class="separator:abd2f2ed7d50c3dc96952f8a61e15817e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae31d0236a3363d8919b2e88399ff1b33"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_animation.html#ae31d0236a3363d8919b2e88399ff1b33">clearSelection</a> = false</td></tr>
<tr class="memdesc:ae31d0236a3363d8919b2e88399ff1b33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the selected object (this button) will be cleared when the animation gets activated.  <a href="#ae31d0236a3363d8919b2e88399ff1b33">More...</a><br /></td></tr>
<tr class="separator:ae31d0236a3363d8919b2e88399ff1b33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a391d626850283ed3b0ced782bae0b2d4"><td class="memItemLeft" align="right" valign="top">EnableCondition&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_animation.html#a391d626850283ed3b0ced782bae0b2d4">ifDisabledOnPlay</a> = EnableCondition.DoNothing</td></tr>
<tr class="memdesc:a391d626850283ed3b0ced782bae0b2d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">What to do if the target game object is currently disabled.  <a href="#a391d626850283ed3b0ced782bae0b2d4">More...</a><br /></td></tr>
<tr class="separator:a391d626850283ed3b0ced782bae0b2d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add23b165673382c985157179d8400269"><td class="memItemLeft" align="right" valign="top">DisableCondition&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_animation.html#add23b165673382c985157179d8400269">disableWhenFinished</a> = DisableCondition.DoNotDisable</td></tr>
<tr class="memdesc:add23b165673382c985157179d8400269"><td class="mdescLeft">&#160;</td><td class="mdescRight">What to do with the target when the animation finishes.  <a href="#add23b165673382c985157179d8400269">More...</a><br /></td></tr>
<tr class="separator:add23b165673382c985157179d8400269"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f7f791f7a7d78b609328602ef1f1081"><td class="memItemLeft" align="right" valign="top">List&lt; <a class="el" href="class_event_delegate.html">EventDelegate</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_animation.html#a2f7f791f7a7d78b609328602ef1f1081">onFinished</a> = new List&lt;<a class="el" href="class_event_delegate.html">EventDelegate</a>&gt;()</td></tr>
<tr class="memdesc:a2f7f791f7a7d78b609328602ef1f1081"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event delegates called when the animation finishes.  <a href="#a2f7f791f7a7d78b609328602ef1f1081">More...</a><br /></td></tr>
<tr class="separator:a2f7f791f7a7d78b609328602ef1f1081"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:af3e0f9612a68de9d9ebb30427716bc2b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3e0f9612a68de9d9ebb30427716bc2b"></a>
static <a class="el" href="class_u_i_play_animation.html">UIPlayAnimation</a>&#160;</td><td class="memItemRight" valign="bottom"><b>current</b> = null</td></tr>
<tr class="separator:af3e0f9612a68de9d9ebb30427716bc2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Play the specified animation on click. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="afe99df78a87e0217498c40ff78ea9b17"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void UIPlayAnimation.Play </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>forward</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Start playing the animation. </p>

</div>
</div>
<a class="anchor" id="a8d04928eb41301c4cb4b6ca7ce946f9f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void UIPlayAnimation.Play </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>forward</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>onlyIfDifferent</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Start playing the animation. </p>

</div>
</div>
<a class="anchor" id="a2c89e1cd6619bfd36a22ca130f08f763"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void UIPlayAnimation.PlayForward </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Play the tween forward. </p>

</div>
</div>
<a class="anchor" id="a605acb0df7576c45eff1ea7e4b645e8d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void UIPlayAnimation.PlayReverse </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Play the tween in reverse. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a02c7edf8e02c531fd63bb7ec3a0f6f8e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Animator UIPlayAnimation.animator</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Target animator system. </p>

</div>
</div>
<a class="anchor" id="ae31d0236a3363d8919b2e88399ff1b33"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool UIPlayAnimation.clearSelection = false</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Whether the selected object (this button) will be cleared when the animation gets activated. </p>

</div>
</div>
<a class="anchor" id="a9d588b3baf27ba6dd26a122baa0559fa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string UIPlayAnimation.clipName</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Optional clip name, if the animation has more than one clip. </p>

</div>
</div>
<a class="anchor" id="add23b165673382c985157179d8400269"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">DisableCondition UIPlayAnimation.disableWhenFinished = DisableCondition.DoNotDisable</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>What to do with the target when the animation finishes. </p>

</div>
</div>
<a class="anchor" id="a391d626850283ed3b0ced782bae0b2d4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EnableCondition UIPlayAnimation.ifDisabledOnPlay = EnableCondition.DoNothing</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>What to do if the target game object is currently disabled. </p>

</div>
</div>
<a class="anchor" id="a2f7f791f7a7d78b609328602ef1f1081"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">List&lt;<a class="el" href="class_event_delegate.html">EventDelegate</a>&gt; UIPlayAnimation.onFinished = new List&lt;<a class="el" href="class_event_delegate.html">EventDelegate</a>&gt;()</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Event delegates called when the animation finishes. </p>

</div>
</div>
<a class="anchor" id="a258bbfffec956070be6c4209b2b0b14c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Direction UIPlayAnimation.playDirection = Direction.Forward</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Which direction to animate in. </p>

</div>
</div>
<a class="anchor" id="abd2f2ed7d50c3dc96952f8a61e15817e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool UIPlayAnimation.resetOnPlay = false</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Whether the animation's position will be reset on play or will continue from where it left off. </p>

</div>
</div>
<a class="anchor" id="a7129ebde8edb46b2353be0dbc1a8dc59"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Animation UIPlayAnimation.target</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Target animation to activate. </p>

</div>
</div>
<a class="anchor" id="afb7d8fcf9427dea42335e7061bea8710"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Trigger UIPlayAnimation.trigger = Trigger.OnClick</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Which event will trigger the animation. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>D:/WorkDir/Unity3D_Work/taidou_arpg/Assets/NGUI/Scripts/Interaction/UIPlayAnimation.cs</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_u_i_play_animation.html">UIPlayAnimation</a></li>
    <li class="footer">Generated on Sat Jan 4 2020 22:30:28 for NGUI by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9 </li>
  </ul>
</div>
</body>
</html>
